Skip to content

Conversation

@ewega
Copy link
Contributor

@ewega ewega commented Dec 5, 2025

⚠️ Pre Checklist

Please complete ALL items in this checklist, and remove before submitting

  • I have read through the Contributing Documentation.
  • I have added relevant tests.
  • I have added relevant documentation.
  • I will add labels to the PR, such as pr-type/bug-fix, pr-type/feature-development, etc.

Summary

Adds an AGENTS.md file for agent onboarding to the project

Does this close any open issues?

Closes #8655

Screenshots

N/A

Other Information

This is one of many methods to onboard agents onto the project for any contributor. It is optimal as it is standardized, but there are many ways to onboard different agents (e.g. .github/copilot-instructions.md, CLAUDE.md).

Would like input from major contributors on if there is any specific information we should add or remove

@ewega ewega marked this pull request as ready for review December 5, 2025 12:34
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. component/docs This issue or PR relates to a document labels Dec 5, 2025
klesh
klesh previously approved these changes Dec 15, 2025
Copy link
Contributor

@klesh klesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for your contribution.

@klesh
Copy link
Contributor

klesh commented Dec 15, 2025

Can you add the Apache License header to the document?

@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Dec 23, 2025
@ewega ewega force-pushed the agent-instruction-file branch from 3ccf10d to a7c1b53 Compare December 23, 2025 15:41
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:XXL This PR changes 1000+ lines, ignoring generated files. labels Dec 23, 2025
@ewega
Copy link
Contributor Author

ewega commented Dec 23, 2025

@klesh Added as requested. The force push you see was me correcting a mistake

@klesh klesh merged commit 5e82fcc into apache:main Dec 25, 2025
@klesh
Copy link
Contributor

klesh commented Dec 25, 2025

Thanks for your contribution!

@ewega ewega deleted the agent-instruction-file branch December 29, 2025 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs This issue or PR relates to a document size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature][Agent Onboarding] Add an AGENTS.md file or similar

2 participants